fix: correct stale documentation and enforce detekt in CI#3
Merged
Conversation
…est counts) - Remove Tink references from README, AGENTS.md, android/AGENTS.md, and encryption-spec.md (Tink was removed in SEC2-A-13, app uses BouncyCastle + JCA) - Fix AGENTS.md security section: challenge-response auth, not JWT/bcrypt - Update server test count from 44 to 456 (40 test classes) - Update server/AGENTS.md: fix util listing, env var table, test suites - Fix disaster-recovery.md: replace JWT/TOTP sections with session invalidation and signing key compromise procedures - Fix recovery flow description to match zero-knowledge architecture - Remove continue-on-error from server detekt CI step (now maxIssues: 0)
…docs - Add KIDSYNC_MAX_SNAPSHOTS_PER_BUCKET, KIDSYNC_MAX_DEVICES_PER_BUCKET, KIDSYNC_SNAPSHOT_RATE_LIMIT, KIDSYNC_ALLOWED_BLOB_CONTENT_TYPES, and KIDSYNC_PUSH_TOKEN_KEY to .env.example with descriptions - Fix server/AGENTS.md: KIDSYNC_SERVER_ORIGIN default is api.kidsync.app, not (unset) Review cycle 1 findings addressed.
- CONTRIBUTING.md: update server test count from 44+ to 456 - Application.kt: tag XForwardedHeaders limitation as DEFERRED(INFRA-01) - DatabaseModule.kt: tag Room migration placeholder as DEFERRED(INFRA-02) Review cycle 2 findings addressed.
…rivacy-policy - disaster-recovery.md: replace stale KIDSYNC_JWT_SECRET/ISSUER/AUDIENCE docker env vars with KIDSYNC_SERVER_ORIGIN, update migration notes - disaster-recovery.md: fix DNS cutover timing (60min session TTL, not 15min) - privacy-policy.md: replace email/password/bcrypt account data with Ed25519 signing key, X25519 encryption key, and device ID Review cycle 3 findings addressed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Comprehensive documentation audit and cleanup across the entire codebase, verified through 3 review cycles.
Changes
Crypto library references (Tink removed in SEC2-A-13):
TinkCryptoManager.ktclass name retained (historical, explained in code comment)Authentication references (app uses Ed25519 challenge-response, not JWT/passwords):
Test count accuracy:
Configuration completeness:
DEFERRED item tracking:
CI enforcement:
continue-on-error: truefrom server detekt step (maxIssues: 0 now enforced)Files Changed (12)
README.md— Tink→BouncyCastle, remove stale JWT_SECRET referenceAGENTS.md— Tink→BouncyCastle, fix auth, update test countsandroid/AGENTS.md— Tink→BouncyCastle+JCA, fix AuthInterceptorserver/AGENTS.md— Fix util listing, env vars, test suites (456 tests)CONTRIBUTING.md— Update test count requirementdocs/protocol/encryption-spec.md— Fix Android library mappingdocs/disaster-recovery.md— Replace JWT/TOTP with session/key proceduresdocs/privacy-policy.md— Replace password auth with keypair auth.env.example— Add missing configuration variables.github/workflows/ci.yml— Enforce server detekt (no continue-on-error)server/.../Application.kt— Add DEFERRED(INFRA-01) tracking IDandroid/.../DatabaseModule.kt— Add DEFERRED(INFRA-02) tracking IDReview Cycles
Test plan
grep -r "TODO" server/src/main android/app/src/mainreturns nothinggrep -r "JWT\|TOTP\|bcrypt" *.md server/AGENTS.md android/AGENTS.md docs/disaster-recovery.md docs/privacy-policy.mdreturns nothing